/**
 * This file is part of 1genia trampoline
 * Copyright (C) 2007-2008 1genia (contact@1genia.com)
 *
 * This library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; version 3 of the License. 
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details. 
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; see the file COPYING.TXT.  If not,
 * write to the Free Software Foundation, Inc., 51 Franklin Street,
 * Fifth Floor, Boston, MA 02110-1301, USA. 
 **/
package com.genia.toolbox.projects.toolbox_basics_project.bean;

import java.util.List;

import com.genia.toolbox.basics.i18n.I18nMessage;

/**
 * an {@link ApplicationParameter} that can be persisted across restart of the
 * application and that can be modified.
 * 
 * @param <TYPE>
 *          the type of the value
 */
public interface PersistableApplicationParameter<TYPE>
    extends ApplicationParameter<TYPE>
{

  /**
   * getter for the category property.
   * 
   * @return the category
   */
  public abstract I18nMessage getCategory();



  /**
   * getter for the name property.
   * 
   * @return the name
   */
  public abstract I18nMessage getName();



  /**
   * getter for the parameterClass property.
   * 
   * @return the parameterClass
   */
  public abstract Class<TYPE> getParameterClass();



  /**
   * getter for the referenceName property.
   * 
   * @return the referenceName
   */
  public abstract String getReferenceName();



  /**
   * returns the value of the {@link ApplicationParameter}.
   * 
   * @return the value of the {@link ApplicationParameter}
   * @see com.genia.toolbox.projects.toolbox_basics_project.bean.ApplicationParameter#getValue()
   */
  public abstract TYPE getValue();



  /**
   * getter for the validationRegularExpressions property.
   * 
   * @return the validationRegularExpressions
   */
  public abstract List<String> getValidationRegularExpressions();



  /**
   * set the current value of the {@link ApplicationParameter}.
   * 
   * @param value
   *          the value of the {@link ApplicationParameter}.
   */
  public abstract void setValue(TYPE value);
}
